Path: / {BASE} / users / {login}

Return the Account data of the requested login

Path parameters:
login - the account name / login name of the new user.

Sub-Resources
Resources
NameDescription
passwordSet the password for the given account
profileUpdate/Save the user profile (foaf) for the given account
rolesSet the roles for the given account

Resource Methods
Method Summary
NameDescription
POST /{BASE}/users/{login}Create a new user account (incl.
GET /{BASE}/users/{login}Return the Account data of the requested login
DELETE /{BASE}/users/{login}?deleteFoaf=…Delete the account with the given login.

Method Detail

POST /{BASE}/users/{login}

Create a new user account (incl. user resource)

HTTP Example:
POST /{BASE}/users/{login}
API Example:

UserManagementWebService.createUser({'login': /* login the account name / login name of the new user. */});

Output:
Response - the {@link org.apache.marmotta.platform.user.webservices.UserWebService.AccountPoJo} of the newly created user.
HTTP return codes:
409 - if an account with the given login already exists
400 - if the login is a reserved keyword: [me, login, anonymous]
500 - on other errors.

GET /{BASE}/users/{login}

Return the Account data of the requested login

HTTP Example:
GET /{BASE}/users/{login}
API Example:

UserManagementWebService.getUser({'login': /* login the account requested */});

Output:
Response - an {@link org.apache.marmotta.platform.user.webservices.UserWebService.AccountPoJo} of the requested account
Produces:
application/json
HTTP return codes:
404 - if no such user exists.

DELETE /{BASE}/users/{login}

Delete the account with the given login.

HTTP Example:
DELETE /{BASE}/users/{login}?deleteFoaf=…
API Example:

UserManagementWebService.deleteUser({'deleteFoaf': /* delFoaf if true, also delete the user profile (foaf) */,
  'login': /* login the account to delete */});

Output:
Response - 200 ok on success
Query parameters:
deleteFoaf - if true, also delete the user profile (foaf)
HTTP return codes:
404 - if no such user exists